home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / btag130.zip / BRAGTAG.DOC < prev    next >
Text File  |  1993-12-11  |  12KB  |  250 lines
  1.                          BragTag version 1.30ß
  2.                          'The TagLine Displayer'
  3.  
  4.                          Copyright(c) 1993   
  5.              All Rights Reserved
  6.  
  7.                          BRAGWARE! -> Rick A.G. Bursey
  8.                    169 Montana Drive Apt. 4
  9.              Stephenville, NF.
  10.              A2N 2T4
  11.              Canada
  12.              Internet: ap374@freenet.carleton.ca
  13.  
  14.  Disclaimer
  15.  ──────────
  16.   I claim no responsibility for any damages or losses caused by the use or 
  17. misuse of this program. It is being distributed "as is" with no warranty of 
  18. any kind being expressed or implied. The user agrees to these terms by the 
  19. use of this program.
  20.  
  21.  Introduction to BragTag
  22.  ───────────────────────
  23.   BragTag is a program which will display a humorous quote each time someone
  24. logs onto or off of your BBS. It does this by creating two different files, 
  25. one containing ANSI escape characters and one containing just plain old ASCII
  26. text. This way both groups of people can view the same tagline quote, those 
  27. who are using ANSI colour graphics and those who do not.
  28.  
  29.  Directions
  30.  ──────────
  31.  BragTag is very easy to setup because it comes with it's own configuration
  32. utility. The easiest way to set up BragTag is to use this utility. BragCfg.exe
  33. will prompt you for the proper information and then create a file called 
  34. "BRAGTAG.CFG", which is used by BRAGTAG each time it creates the two display 
  35. files. This utility has built in context-sensitive help to guild you through
  36. the configuration process. 
  37.  But if you would rather make your own config file with a text editor this
  38. is the format of the config file:
  39.  
  40.  SysOp Name                     <- SysOp put your name on this line
  41.  Header Line                    <- a line displayed before the quote box
  42.  Footer Line                    <- a line displayed after the quote box
  43.  ANSI File Name and Path        <- the place to put this file when created
  44.  ASCII File Name and Path       <- the place to put this file when created
  45.  PCBoard File Name and Path     <- the place to put this file when created
  46.  WildCat File Name and Path     <- the place to put this file when created
  47.  TagLine File Name and Path     <- the place where your taglines are located
  48.  Clear Screen                   <- clear screen YES or NO 
  49.  Border Style                   <- The border style to use in the display
  50.  
  51.  Config File Explained                                  
  52.  ─────────────────────
  53.  Here is a more detailed discription of the config file.
  54.  
  55.   Sysop Name:
  56.   -----------
  57.   This line will contain the name that will be displayed to the users as the
  58.   SysOp. More than one name can be included here, but must be on the same 
  59.   line.
  60.  
  61.   Header Line:
  62.   ------------
  63.   The line of text to display before the tagline box. This can be a greeting
  64.   of some kind or a small advertisement.
  65.  
  66.   Footer Line:
  67.   ------------
  68.   The line of text to display after the tagline box. This too can be a 
  69.   greeting of some kind.
  70.  
  71.   ANSI File:
  72.   ----------
  73.   The name and location of the created ANSI file. This is where BragTag will
  74.   put the ANSI file. This will be the same path as the one you pass to your
  75.   BBS software so it can display this file to the callers. This is file that
  76.   contains the ANSI escape codes so that colour graphics will be displayed to 
  77.   them while they are online.
  78.   Enter 'NULL' (without the quotes) on this line if you do not wish to use
  79.   this file format. This way the file will NOT be created.
  80.  
  81.   ASCII File:
  82.   -----------
  83.   The name and location of the created ASCII file. This is where BragTag will
  84.   put the plain text file. This will be the same path as the one you pass to
  85.   your BBS software so it can display this file to the callers. This file
  86.   does NOT contain anything but pure ASCII text so it can be displayed to
  87.   any caller while they are online.
  88.   Enter 'NULL' (without the quotes) on this line if you do not wish to use
  89.   this file format. This way the file will NOT be created.
  90.  
  91.   PCBoard File:
  92.   -------------
  93.   The name and location of the created PCBoard file. This is where BragTag 
  94.   will put the PCBoard compatable file. This will be the same path as the one
  95.   you pass to your PCBoard BBS software so it can be displayed th callers.
  96.   This file contains the @Codes (AT Codes) so that colour files can be 
  97.   displayed from a PCBoard system. This file will NOT be displayed correctly
  98.   on NON PCBoard systems.
  99.   Enter 'NULL' (without the quotes) on this line if you do not wish to use
  100.   this file format. This way the file will NOT be created.
  101.  
  102.   WildCat File:
  103.   ------------
  104.   The name and location of the created WildCat file. This is where BragTag 
  105.   will put the WildCat compatable file. This will be the same path as the one
  106.   you pass to your WildCat BBS software so it can be displayed th callers.
  107.   This file contains the @Codes (AT Codes) so that colour files can be 
  108.   displayed from a WildCat system. This file will NOT be displayed correctly
  109.   on NON WildCat systems.
  110.   Enter 'NULL' (without the quotes) on this line if you do not wish to use
  111.   this file format. This way the file will NOT be created.
  112.  
  113.   TagLine File:
  114.   -------------
  115.   The name and location of the input data file which contains the taglines. 
  116.   This can be any tagline file, even one that you are using with your favorite
  117.   off-line mail reader. If BragTag cannot find the file in this location it 
  118.   not be able to create the two display files and will display a error message
  119.   to you the Sysop.
  120.  
  121.   Clear Screen:
  122.   -------------
  123.   You have the option to clear the screen before displaying the PCBoard,
  124.   WildCat and ANSI files to callers. This works only for the PCBoard, WildCat
  125.   and ANSI colour graphics users. Put a YES or NO on this line. The default 
  126.   for this option is YES, so if any value other than YES or No is on this 
  127.   line the screen will be cleared before displaying the output files.
  128.  
  129.   Border Style:
  130.   -------------
  131.   The border style to use in the display. The default is RANDOM or you may 
  132.   pick one of the following styles:
  133.  
  134.            ┌───────────┐     ╔═══════════╗     ╓───────────╖
  135.            │  SINGLE   │     ║  DOUBLE   ║     ║  ONETOP   ║
  136.            └───────────┘     ╚═══════════╝     ╙───────────╜
  137.  
  138.            ╒═══════════╕     ░░░░░░░░░░░░░     ▒▒▒▒▒▒▒▒▒▒▒▒▒
  139.            │  TWOTOP   │     ░   LIGHT   ░     ▒  MEDIUM   ▒
  140.            ╘═══════════╛     ░░░░░░░░░░░░░     ▒▒▒▒▒▒▒▒▒▒▒▒▒
  141.  
  142.            ▓▓▓▓▓▓▓▓▓▓▓▓▓     █████████████     ▐▀▀▀▀▀▀▀▀▀▀▀▌
  143.            ▓   DARK    ▓     █   WIDE    █     ▐   THIN    ▌
  144.            ▓▓▓▓▓▓▓▓▓▓▓▓▓     █████████████     ▐▄▄▄▄▄▄▄▄▄▄▄▌
  145.  
  146.   As well as the above border styles you may also have NONE as a border style.
  147. If NONE is chosen, no border will be created around the tagline.  
  148.   If an invalid choice is entered on this line the program will choose a
  149. border style at random. This way your display files will still be created
  150. properly and your BBS software will NOT crash or whatever, because of an
  151. inproper value being entered on this line of the configuration file.
  152.  
  153.  Warning!
  154.  ──────── 
  155.  All of the lines in the configuration file must be used, or you'll have
  156. strange results in your display files. If you do NOT wish to have BragTag
  157. create a specific file type, put NULL as the name of the output file. When
  158. BragTag reads the config file it will not create any files that have NULL
  159. entered as the pathname.
  160.  Both BRAGTAG and BRAGCFG will look in the current directory for the 
  161. BRAGTAG.CFG file. If BragTag cannot find the configuration file in the same 
  162. directory as it resides it will abort with a warning message, you will need 
  163. then to create the config file either with the BRAGCFG.EXE or with your own 
  164. text editor using the above mentioned format.
  165.  
  166.  ERRORLEVELS
  167.  ───────────
  168.  If you are calling BragTag from a BATCH file here is a list of the 
  169. errorlevels that could be returned to DOS upon completion:
  170.  Errorlevel    Meaning
  171.  ----------    -------
  172.          0     No error, program executed with no problems occuring
  173.          1     Could NOT open the tagline file properly, might not exist
  174.          2     Could NOT rea